GetIconProperty(IconID@"IconTitle", #center)

TRUE The QuickTime movie is cropped around the center of the movie.

FALSE The QuickTime movie is cropped from the top left corner of the movie

The center property can be tested and set.
 

SetIconProperty(@"QT3", #crop,TRUE) -- crop must be TRUE
SetIconProperty(@"QT3", #center,TRUE)

controller
 

GetIconProperty(IconID@"IconTitle", #controller)

TRUE The QuickTime movie's controller is visible.

FALSE The QuickTime movie's controller is hidden.

The controller property can be tested and set. The QuickTime movie must be set to display direct to screen for the controller to be visible.
 

state := GetIconProperty(IconID@"StarBurst", #controller)
SetIconProperty(IconID@"StarBurst", #controller, ~state)

 
crop
 

GetIconProperty(IconID@"IconTitle", #crop)

TRUE The QuickTime movie isn't scaled to fit the sprite. It's cropped to fit inside the sprite rectangle.

FALSE The QuickTime movie is scaled—either stretched or shrunk—to fit the sprite

The crop property can be tested and set.
 

SetIconProperty(@"QT3", #crop,TRUE)

 
cuePointNames
 

This property returns a linear list of named cue points set in the QuickTime movie file. If there are no cue points in the file, the value returned is []. Use SoundEdit to insert a cue point in a QuickTime file. SoundEdit uses the term "marker" to refer to the cue points.

Newly imported QuickTime movies have the streaming property set TRUE by default. This means that cue points will be unavailable until the streaming property is set to FALSE.
 

 
cuePointTimes
 

This property returns a linear list of cue point times (in milliseconds) set in the QuickTime movie file. If there are no cue points in the file, the value returned is []. Use SoundEdit to insert a cue point in a QuickTime file. SoundEdit uses the term "marker" to refer to the cue points.

Newly imported QuickTime movies have the streaming property set TRUE by default. This means that cue points will be unavailable until the streaming property is set to FALSE.
 

currentTime
 

digitalVideoType 
 

 
directToStage
 

GetIconProperty(IconID@"IconTitle", #directToStage)

TRUE The QuickTime movie plays in front of all other layers. No objects can appear in front of the movie except as a mask.

FALSE The QuickTime movie can appear in any layer in the Presentation window.

The directToStage property can be tested and set.
 

SetIconProperty(@"QT3", #directToStage,TRUE)

duration
 

filename
 

GetIconProperty(IconID@"IconTitle", #filename)

The filename property can be tested and set.
 

SetIconProperty(@"QT3", #filename, "sample.mov")
SetIconProperty(@"QT3", #filename, "C:\qtvr_example.mov")
SetIconProperty(@"QT3", #filename, ¬
"http://www.apple.com/quicktime/samples/qtvrimages/saumur_multirate.mov")

frameRate
 

GetIconProperty(IconID@"IconTitle", #frameRate)

-2 plays every frame as fast as possible

-1 plays every frame at the normal rate

0 plays the movie in sync with the soundtrack

A positive number plays the movie at that frame rate

TheframeRate property can be tested and set.
 
invertMask
 

GetIconProperty(IconID@"IconTitle", #invertMask)

TRUE The QuickTime movie is drawn in the white pixels of the movie's mask.

FALSE The QuickTime movie is drawn in the black pixels of the movie's mask.

The invertMask property can be tested and set. The default state value is FALSE.

Specify a mask icon using the mask icon property before setting invertMask. The QuickTime movie must be set to display direct to screen for invertMask to have an effect.
 

state := GetIconProperty(IconID@"StarBurst", #invertMask)
SetIconProperty(IconID@"StarBurst", #invertMask, ~state)

isPastCuePoint
 

If cuePointID is a number, isPastCuePoint returns 1 if the cue point has passed and 0 if it hasn't been passed. For example, if cuePointID is 2, then isPastCuePoint will return 1 if the second cue point in the QuickTime movie has passed.

If cuePointID is a name, isPastCuePoint returns the number of cue points with that name that have passed.

If the value specified for cuePointID doesn't exist in the QuickTime movie, the function returns 0.

The number returned by isPastCuePoint is based on the absolute position of the sprite in the QuickTime movie. For example, if a movie passes cue point Main and then loops and passes Main again, isPastCuePoint returns 1 instead of 2.

When the result of isPastCuePoint is treated as a Boolean value, the function returns TRUE if any cue points identified by cuePointID have passed, and FALSE if no cue points are passed.

Use SoundEdit to insert a cue point in a QuickTime file. SoundEdit uses the term "marker" to refer to the cue points.

Newly imported QuickTime movies have the streaming property set TRUE by default. This means that cue points will be unavailable until the streaming property is set to FALSE.
 

loop
 

GetIconProperty(IconID@"IconTitle", #loop)

SetIconProperty(IconID@"StarBurst", #loop, TRUE)

loopBounds
 

GetSpriteProperty(IconID@"IconTitle", #loopBounds)

[startTime, endTime]

The startTime and endTime parameters must meet these requirements:

	Both parameters must be integers that specify times in ticks (60ths of a second).
	The values must range from 0 to the duration of the QuickTime movie.
	The starting time must be less than the ending time.

If any of these requirements is not met, the QuickTime movie loops through its entire duration.

The loopBounds property has no effect if the movie's loop property is set to FALSE. Authorware uses these rules to decide how to loop the movie:

	If the ending time specified by loopBounds is reached, the movie loops back to the starting time.
	If the end of the movie is reached, the movie loops back to the start of the movie.
	Authorware stops when it reaches the ending time specified by loopBounds or the end of the movie, whichever comes first.

The loopBounds property can be tested and set. The default is [0,0].
 

SetSpriteProperty(@"QuickTimeIcon", #loopBounds,[(16 * 60),(32 * 60)])

 
mask
 

Authorware always aligns the upper-left corner of the contents of the mask icon with the upper-left corner of the QuickTime movie sprite. The mask can't be moved and isn't affected by the center or crop properties of its associated icon.

For best results, set a QuickTime icon's mask property before any of its sprites appear in the Presentation window. Setting or changing the mask property while the sprite appears in the Presentation window can have unpredictable results (for example, the mask might appear as a "freeze frame" of the digital video at the moment the mask property took effect).

Masking is an advanced feature; you may need to do some experimentation to achieve your goal.

The mask property can be tested and set. To remove a mask, set the mask property to 0.
 

SetIconProperty(@"Peeping Tom", #mask, @"Keyhole")

mediaBusy
 

 
mediaReady
 

 
mostRecentCuePoint
 

mouseLevel
 

GetSpriteProperty(IconID@"IconTitle", #mouseLevel)

#controller passes clicks only on the movie controller. This is the standard behavior without the QuickTime Xtra.

#all passes all mouse clicks within the sprite's bounding rectangle.

#none passes no mouse clicks.

The mouseLevel property can be tested and set. The default value is #controller.
 

if Find(" QTVR, IconTitle(ExecutingIconID)) then
        setSpriteProperty(ExecutingIconID, #mouseLevel, #all)
    else
        SetSpriteProperty(ExecutingIconID, #mouseLevel, #none)
end if

mRate
 

GetSpriteProperty(IconID@"IconTitle", #mRate)

1 is normal forward play

-1 is reverse

0 is stop

Higher and lower values are possible. For example, a value of 0.5 causes the digital video to play slower than normal. However, frames may be dropped when the value of mRate exceeds 1, depending on the performance of the computer the movie is playing on.

The mRate property can be tested and set.
 

if (GetSpriteProperty(@"QT3", #mRate)) = 1 then
        SetSpriteProperty(@"QT3", #mRate,-1)
    else
        SetSpriteProperty(@"QT3", #mRate,1)
end if

mTime
 

GetSpriteProperty(IconID@"IconTitle", #mTime)

The mTime property can be tested and set.
 

SetSpriteProperty(@"QT3", #mTime, 0)

pausedAtStart
 

GetIconProperty(IconID@"IconTitle", #pausedAtStart)

TRUE The Paused checkbox is checked.

FALSE The Paused checkbox is not checked.

The pausedAtStart property can be tested and set.
 

SetIconProperty(@"QT3", #pausedAtStart,TRUE)

percentStreamed
 

preload
 

GetIconProperty(IconID@"IconTitle", #preload)

TRUE The Enable Preload checkbox is checked.

FALSE The Enable Preload checkbox is not checked.

The preload property can be tested and set.
 

SetIconProperty(@"QT3", #preload,TRUE)

QuickTimeVersion
 

Windows users: If there are multiple versions of QuickTime 3.0 or later installed, QuickTimeVersion returns the latest version. If a version before QuickTime 3.0 is installed, QuickTimeVersion returns 2.1.2 regardless of the version installed.
 

if QuickTimeVersion() >= 3 then
	JumpFile "SplashVideo"
else
	JumpFile "SplashAnimated"
end if

rotation
 

GetIconProperty(IconID@"IconTitle", #rotation)

If the sprite's crop property is set to TRUE, rotating the sprite frequently moves part of the image out of the viewable area; when the sprite's crop property is set to FALSE, the image is scaled to fit within the bounding rectangle (which may cause image distortion).

You specify the rotation in the degrees parameter. The rotation property can be tested and set. The default value is 0.
 

SpriteRotation := GetIconProperty(IconID@"QuickTime", #rotation)

SetIconProperty(IconID@"QuickTime", #rotation, SpriteRotation + 180)

scale
 

GetIconProperty(IconID@"IconTitle", #scale)

[xPercent, yPercent]

The xPercent parameter specifies the amount of horizontal scaling; the yPercent parameter specifies vertical scaling.

When the sprite's crop property is set to TRUE, the scale property can be used to simulate zooming within the sprite's bounding rectangle. When the sprite's crop property is set to FALSE, the scale property is ignored.

The scale property can be tested and set. The default value is [100,100].
 

SetIconProperty(IconID@"QT3", #scale,[150,150])

 
setTrackEnabled
 

if (CallSprite(@"QT3", #trackEnabled,1) ) = 0 then
        CallSprite(@"QT3", #setTrackEnabled,1,TRUE)
    else
        CallSprite(@"QT3", #setTrackEnabled,1,FALSE)
end if

sound
 

GetIconProperty(IconID@"IconTitle", #sound)

TRUE The QuickTime movie's sound is turned on.

FALSE The QuickTime movie's sound is turned off.

The sound property can be tested and set.
 

state := GetIconProperty(IconID@"StarBurst", #sound)
SetIconProperty(IconID@"StarBurst", #sound, ~state)

streaming
 

GetIconProperty(IconID@"IconTitle", #streaming)

If a streaming QuickTime file contains cuepoints, then you must set the text track to be preloaded (use a QuickTime editor such as MoviePlayerPro to do this). If you do not preload the text track, Authorware will disable the cuepoints in the QuickTime file so it can stream without downloading the entire file. You will need to reload the file after editing the QuickTime movie to preload the cuepoint track.

Newly imported QuickTime movies have the streaming property set TRUE by default. This means that cue points will be unavailable until the streaming property is set to FALSE.

The streaming property can be tested and set.

SetIconProperty(IconID@"StarBurst", #streaming, FALSE)

timeScale
 

trackCount
 

NumTracks := CallSprite(@"QT3", #trackCount)

trackEnabled
 

	When trackEnabled is TRUE, the specified track is enabled.
	When trackEnabled is FALSE, the specified track is disabled.

 

if (CallSprite(@"QT3", #trackEnabled,1) ) = 0 then
        CallSprite(@"QT3", #setTrackEnabled,1,TRUE)
    else
        CallSprite(@"QT3", #setTrackEnabled,1,FALSE)
end if

trackNextKeyTime
 

trackNextSampleTime
 

trackPreviousKeyTime
 

trackPreviousSampleTime
 

trackStartTime
 

StartTime := CallSprite(@"QT3", #trackStartTime, 2)

trackStopTime
 

EndTime := CallSprite(@"QT3", #trackStopTime, 2)

trackType
 

If CallSprite(@"QT3", #trackType, 2) = #sound then
        SoundTrack := "sound available"
    else
        SoundTrack := "no sound available"
end if

trackText
 

translation
 

GetIconProperty(IconID@"IconTitle", #translation)

SetSpriteProperty(IconID@"IconTitle", #translation, [xOffset, yOffset])

GetSpriteProperty(IconID@"IconTitle", #translation)
 

Sprite property
 

[xOffset, yOffset]

The xOffset parameter specifies the horizontal offset, in pixels, from the sprite's default location; the yOffset parameter specifies the vertical offset. You can specify offsets as positive or negative integers.

When the sprite's crop property is set to TRUE, the translation property can be used to mask portions of the QuickTime movie by moving them outside the bounding rectangle. When the crop property is set to FALSE, the translation property is ignored and the sprite is always positioned at the upper-left corner of the sprite's rectangle.

The translation property can be tested and set. The default is [0,0].
 

horizontalPosition := GetSpriteProperty(IconID@"QuickTime", #translation)
if horizontalPosition < 320 then
	SetSpriteProperty(IconID@"QuickTime", #translation, horizontalPosition + [10,0])
end if

video
 

GetIconProperty(IconID@"IconTitle", #video)

TRUE The QuickTime movie's video is visible.

FALSE The QuickTime movie's video is hidden.

The video property can be tested and set.
 

state := GetIconProperty(IconID@"StarBurst", #video)
SetIconProperty(IconID@"StarBurst", #video, ~state)

volumeLevel
 

GetSpriteProperty(IconID@"IconTitle", #volumeLevel)

if GetSpriteProperty(IconID@"QuickTime", #volumeLevel) > 200 then
	SetSpriteProperty(IconID@"QuickTime", #volumeLevel,150)
end if